<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Type_struct</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1 id="MPI_Type_struct">MPI_Type_struct</H1>
Creates a struct datatype 
<H2>Synopsis</H2>
<PRE>
</PRE>
<PRE>
int MPI_Type_struct(int count, int array_of_blocklengths[],
                    MPI_Aint array_of_displacements[],
                    MPI_Datatype array_of_types[], MPI_Datatype *newtype)
</PRE>

<P>
<H2>Input Parameters</H2>
<DL>
<DT><B>count </B> <DD> number of blocks also number of entries in arrays array_of_types, array_of_displacements, and array_of_blocklengths (non-negative integer)

<DT><B>array_of_blocklengths </B> <DD> number of elements in each block (non-negative integer)

<DT><B>array_of_displacements </B> <DD> byte displacement of each block (integer)

<DT><B>array_of_types </B> <DD> types of elements in each block (handle)
</DL>
<P>
<H2>Output Parameters</H2>
<DL>
<DT><B>newtype </B> <DD> new datatype (handle)
</DL>
<P>
<H2>Notes</H2>
If an upperbound is set explicitly by using the MPI datatype <tt>MPI_UB</tt>, the
corresponding index must be positive.
<P>
The MPI standard originally made vague statements about padding and alignment;
this was intended to allow the simple definition of structures that could
be sent with a count greater than one.  For example,
<PRE>
    struct { int a; char b; } foo;
</PRE>

may have <tt>sizeof(foo) &gt; sizeof(int) + sizeof(char)</tt>; for example,
<tt>sizeof(foo) == 2*sizeof(int)</tt>.  The initial version of the MPI standard
defined the extent of a datatype as including an <em>epsilon</em> that would have
allowed an implementation to make the extent an MPI datatype
for this structure equal to <tt>2*sizeof(int)</tt>.
However, since different systems might define different paddings, there was
much discussion by the MPI Forum about what was the correct value of
epsilon, and one suggestion was to define epsilon as zero.
This would have been the best thing to do in MPI 1.0, particularly since
the <tt>MPI_UB</tt> type allows the user to easily set the end of the structure.
Unfortunately, this change did not make it into the final document.
Currently, this routine does not add any padding, since the amount of
padding needed is determined by the compiler that the user is using to
build their code, not the compiler used to construct the MPI library.
A later version of MPICH may provide for some natural choices of padding
(e.g., multiple of the size of the largest basic member), but users are
advised to never depend on this, even with vendor MPI implementations.
Instead, if you define a structure datatype and wish to send or receive
multiple items, you should explicitly include an <tt>MPI_UB</tt> entry as the
last member of the structure.  For example, the following code can be used
for the structure foo
<PRE>
    blen[0] = 1; array_of_displacements[0] = 0; oldtypes[0] = MPI_INT;
    blen[1] = 1; array_of_displacements[1] = &amp;foo.b - &amp;foo; oldtypes[1] = MPI_CHAR;
    blen[2] = 1; array_of_displacements[2] = sizeof(foo); oldtypes[2] = MPI_UB;
    MPI_Type_struct(3, blen, array_of_displacements, oldtypes, &amp;newtype);
</PRE>

<P>
<H2>Removed Function</H2>
The current MPI standard defines this routine as removed. The user should use
the replacement routine.
The replacement for this routine is <tt>MPI_Type_create_struct</tt>.
<P>
<H2>Thread and Interrupt Safety</H2>
<P>
This routine is thread-safe.  This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks.  However, the routine is not interrupt safe.  Typically,
this is due to the use of memory allocation routines such as <tt>malloc
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
<P>
<H2>Notes for Fortran</H2>
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
</tt>is an integer and has the same meaning as the return value of the routine
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
<tt>call</tt> statement.
<P>
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
</tt>in Fortran.
<P>
<H2>Errors</H2>
<P>
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
C routines as the value of the function and Fortran routines in the last
argument.  Before the value is returned, the current MPI error handler is
called.  By default, this error handler aborts the MPI job.  The error handler
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
its use is deprecated.  The predefined error handler
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Note that MPI does <em>not</em> guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
<P>
<DL>
<DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
</DL>
<DL>
<DT><B>MPI_ERR_OTHER </B> <DD> Other error; use <tt>MPI_Error_string</tt> to get more information
about this error code. 
</DL>
<P>
</BODY></HTML>
